Syslog Configuration

The syslog key is used for the section of loggerProps that is relevant for system Logs.

Properties File

The following is an example of the loggerProps object of the properties.json file.

{
  "loggerProps": {
    "syslog": {}
  }
}

Examples

The examples below show the options available in the syslog section of the properties.

Full Example

{
    "loggerProps": {
        "syslog": {
            "level": "warning",
            "host": "localhost",
            "port": 514,
            "protocol": "unix",
            "path": "/var/run/syslog",
            "pid": 24528,
            "facility": "local0",
            "localhost": "localhost",
            "type": "BSD",
            "app_name": "node",
            "eol": "\r"
        }
    }
}

Minimal Example for Mac OS X

{
  "syslog": {
    "level": "warning",
    "protocol": "unix",
    "path": "/var/run/syslog"
  }
}

Syslog Properties in JSON Schema

The full set of options that are available are detailed in the following JSON schema.

syslog Properties JSON schema

{
  "title": "System Log Properties",
  "description": "syslog section of loggerProps in properties.json",
  "type": "object",
  "properties": {
    "syslog": {
      "type": "object",
      "properties": {
        "level": {
          "type": "string",
          "description": "The minimum severity level to log. Pronghorn
                          will send log messages to the syslog server
                          for messages associated with the specified
                          severity and higher. Error only logs error
                          messages. Debug logs all messages.",
          "enum": [ "error", "warning", "info", "debug" ]
        },
        "host": {
          "type": "string",
          "description": "The hostname or IP address of the host
                          running syslogd.",
          "default": "localhost"
        },
        "port": {
          "type": "number",
          "description": "The host transport port number where syslogd
                          is listening.",
          "default": "514"
        },
        "protocol": {
          "type": "string",
          "description": "The transport protocol to log over. Can
                          specify UDP, TCP, or Unix socket.",
          "enum": [ "udp4", "udp6", "tcp4", "tcp6", "unix", "unix-connect" ]
        },
        "path": {
          "type": "string",
          "description": "For Unix socket transport, the path to the
                          syslog dgram socket.
                          (i.e. /dev/log or /var/run/syslog for OS X)"
        },
        "pid": {
          "type": "number",
          "description": "It is good practice to include some
                          information about the process on the
                          device that generates messages. PID is
                          Pronghorn's process ID. Not used."
          "default": "process.pid"
        },
        "facility": {
          "type": "string",
          "description": "Syslog facility to use.",
          "default": "local0"
        },
        "localhost": {
          "type": "string",
          "description": "It is good practice to include some
                          information about the process on the
                          device that generates messages. The
                          localhost property is the name of the
                          host originating syslog messages.",
          "default": "localhost"
        },
        "type": {
          "type": "string",
          "description": "The type of the syslog protocol to use,
                          BSD for RFC3164 or 5424 for RFC5424.",
          "enum": [ "BSD", "5424" ],
          "default": "BSD"
        },
        "app_name": {
          "type": "string",
          "description": "It is good practice to include some
                          information about the process on the
                          device that generates messages. The
                          app_name property is the name of the
                          application originating syslog
                          messages."
          "default": "process.title"
        },
        "eol": {
          "type": "string",
          "description": "The end of line character to be added
                          to the end of the message. If not set,
                          messages will be sent unmodified."
        }
      },
      "required": [ "level", "protocol" ],
      "additionalProperties": false
    }
  },
  "required": ["syslog"]
}

Configure Syslog

1. Log in to Itential Automation Platform (IAP) as an administrator.

2. Go to the Settings > Properties page to open IAP properties.

3. Click Logging to show the logging properties.

4. Add a syslog key and object value. For example:

   "syslog": {
     "level": "info",
     "host": "127.0.0.1",
     "port": 514,
     "protocol": "udp4"
   }

5. Click Save.

6. Restart IAP.

Configure Application Log Settings

To access the change log:

1. Go to Settings.

2. Click System. The system dashboard displays.

   

3. Click Applications.

   

4. Select the name of the appropriate application from the list.

   

5. The application Change Log displays.

   

   Note: As of now the Change Log is displayed only for applications, not adapters. Additionally, the PH reference numbers are not active links; these are for reference only when calling the Itential Service Desk (ISD) for support.

6. From this page, you can:

   • Change the Log Settings, as needed. Click Update to apply your changes.
   • Stop and Restart the application using the appropriate icon.

Stop Application

Restart Application